package com.itcam.cm.manager.config;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 该类是 Knife4j 的配置类，用于配置 Swagger 文档的分组和自定义接口信息
 * 通过 Spring 的 @Configuration 注解将该类标记为配置类，Spring 会自动扫描并加载其中的配置
 */
@Configuration
public class Knife4jConfig {

    /**
     * 创建一个名为 "admin-api" 的 API 接口分组
     * 该分组包含所有请求路径以 "/admin/" 开头的接口
     *
     * @return 一个 GroupedOpenApi 对象，代表一个 API 接口分组
     */
    @Bean
    public GroupedOpenApi adminApi() {
        // 创建一个 api 接口的分组
        return GroupedOpenApi.builder()
                // 设置分组名称为 "admin-api"
                .group("admin-api")
                // 配置接口请求路径规则，匹配所有以 "/admin/" 开头的路径
                .pathsToMatch("/admin/**")
                .build();
    }

    /**
     * 自定义 Swagger 文档的接口信息
     * 包括文档的标题、版本、描述以及作者信息
     *
     * @return 一个 OpenAPI 对象，包含自定义的接口信息
     */
    @Bean
    public OpenAPI customOpenAPI() {
        // 创建一个 OpenAPI 对象，并设置其信息
        return new OpenAPI()
                .info(new Info()
                        // 设置文档标题为 "云汇购 API 接口文档"
                        .title("云汇购API接口文档")
                        // 设置文档版本为 "1.0"
                        .version("1.0")
                        // 设置文档描述为 "云汇购 API 接口文档"
                        .description("云汇购API接口文档")
                        // 设定作者信息，作者名称为 "itcam"
                        .contact(new Contact().name("itcam")));
    }
}
